CimPointAlarm Json Schema

In This Topic

Description

object contains the point alarm information for a CIMPLICITY point

Overview

CimPointAlarm

object contains the point alarm information for a CIMPLICITY point

Alarm : CimAlarm

object provides an interface to CIMPLICITY Alarm configuration

AckTimeout : integer

is a long integer that indicates when automatic alarm acknowledgement should happen. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm

AlarmClass : string

is a string containing the class of the alarm

AlarmDescription : string

is a string containing the description of the alarm, This attribute shall be ignored in case of point alarm

AlarmID : string

is a string containing the Alarm ID. When accessed from a Point Alarm, this property is read-only because the Alarm ID is the same as the Point ID

AlarmMessage : string

is a string containing the alarm message. Note When accessed from a Point Alarm, this property is read-only because the structure of the point alarm message defines the alarm message

AlarmTypeID : string

is a string containing the alarm type id of the alarm. When accessed from a Point Alarm, this property is read-only because the structure of the point alarm message defines the Alarm Type Id

Changeapproval : CimChangeapprovalEnum

defines different change approval data setting. The numeric value of these enumerations can be used in an expression of a class data item for the $APPROVAL_TYPE field

DeleteOpt : CimAlarmDelOptEnum

defines the deletion options available for an alarm

HelpFileName : string

is a string containing the name of the alarm help file. The string must be prefixed with AM_HELP:\ in order for the file to be found by the alarm viewer and must have the extension HLP.

HiAckTimeout : integer

The CimAlarm.HiAckTimeout is a long integer that indicates when automatic alarm acknowledgement should happen while the alarm in the Warning High state. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm

HiDeleteOpt : CimAlarmDelOptEnum

defines the deletion options available for an alarm

HiHiAckTimeout : integer

The CimAlarm.HiHiAckTimeout is a long integer that indicates when automatic alarm acknowledgement should happen while the alarm in the Alarm High state. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm

HiHiDeleteOpt : CimAlarmDelOptEnum

defines the deletion options available for an alarm

HiHiLogOpt : string

The CimAlarm.HiHiLogOpt is a string that indicates what the alarm transitions in the Alarm High state should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated

HiHiRepeatTimeout : integer

is a long integer that indicates when automatic alarm repeat should occur while the alarm is in the Alarm High state. 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm

HiHiResetAllowed : boolean

is a boolean that indicates if the alarm can be manually reset when it is in the Alarm High state

HiHiResetTimeout : integer

The CimAlarm.HiHiResetTimeout is a long integer that indicates when automatic alarm reset should happen while the alarm in the Alarm High state. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm

HiLogOpt : string

The CimAlarm.HiLogOpt is a string that indicates what the alarm transitions in the Warning High state should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated

HiRepeatTimeout : integer

is a long integer that indicates when automatic alarm repeat should occur while the alarm is in the Warning High state. 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm

HiResetAllowed : boolean

is a boolean that indicates if the alarm can be manually reset when it is in the Warning High state

HiResetTimeout : integer

The CimAlarm.HiResetTimeout is a long integer that indicates when automatic alarm reset should happen while the alarm in the Warning High state. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm

LoAckTimeout : integer

is a long integer that indicates when automatic alarm acknowledgement should happen while the alarm in the Warning Low state. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm.

LoDeleteOpt : CimAlarmDelOptEnum

defines the deletion options available for an alarm

LoLoAckTimeout : integer

is a long integer that indicates when automatic alarm acknowledgement should happen while the alarm in the Alarm Low state. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm

LoLoDeleteOpt : CimAlarmDelOptEnum

defines the deletion options available for an alarm

LoLoLogOpt : string

is a string that indicates what the alarm transitions in the Alarm Low state should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated

LoLoRepeatTimeout : integer

is a long integer that indicates when automatic alarm repeat should occur while the alarm is in the Alarm Low state. 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm

LoLoResetAllowed : boolean

is a boolean that indicates if the alarm can be manually reset when it is in the Alarm Low state

LoLoResetTimeout : integer

The CimAlarm.LoLoResetTimeout is a long integer that indicates when automatic alarm reset should happen while the alarm in the Alarm Low state. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm

LoLogOpt : string

The CimAlarm.LoLogOpt is a string that indicates what the alarm transitions in the Warning Low state should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated

LoRepeatTimeout : integer

is a long integer that indicates when automatic alarm repeat should occur while the alarm is in the Warning Low state. 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm

LoResetAllowed : boolean

is a boolean that indicates if the alarm can be manually reset when it is in the Warning Low state

LoResetTimeout : integer

is a long integer that indicates when automatic alarm reset should happen while the alarm in the Warning Low state. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm

LogOpt : string

The CimAlarm.LogOpt is a string that indicates when the alarm should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated

MaxStacked : integer

is a long integer that indicates how many alarms to stack. Defaults to zero if not specified. Maximum value is 20

Published : boolean

is a boolean used to enable or disable publishing to SOA for an alarm. Defaults to FALSE for a new alarm

RepeatTimeout : integer

is a long integer that indicates when automatic alarm repeat should occur 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm

ResetAllowed : boolean

is a boolean that indicates if the alarm can be manually reset

ResetTimeout : integer

The CimAlarm.ResetTimeout is a long integer that indicates when automatic alarm reset should happen. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm

Routing : Array[string]

returns an object containing the alarm routing for the alarm

Severity : integer

is a short that indicates the alarm severity

AlarmConfigured : boolean

is a boolean indicating if alarming is configured for the point

AlarmCriteria : CimPointAlarmEnum

defines types of alarming available

AlarmDelay : boolean

is a boolean indicating if the alarm generation should be delayed. When alarm delay is enabled specify the TimeInterval and TimeUnit for the delay. AlarmDelay cannot be used with a Rate of Change alarm criteria

AlarmHigh : string

contains a variant indicating the alarm high limit for the point

AlarmLow : string

contains a variant indicating the alarm low limit for the point

AlarmMessage : string

is a string containing the point alarm message to be used when an alarm is generated for the point

AlarmOffDelay : boolean

is a boolean indicating if the moving alarm to normal state should be delayed. When alarm off delay is enabled specify the TimeInterval and TimeUnit for the delay. AlarmOffDelay cannot be used with a Rate of Change alarm criteria

AlarmStrID : integer

is a integer containing the Alarm String to use when generating point alarms. Defaults to 1

AlarmValueUpdate : boolean

is a boolean indicating if the %VAL field in the alarm message should be updated while the point is in ana alarm state

DeviationPtID : string

is a string containing the name of the deviation point. The deviation point must be specified when the alarm criteria is cimAlarmDeviation

HiDelayInterval : string

is a variant containing a numeric value indicating the delay interval when alarm goes into the Warning High state

HiDelayUnit : CimTimeUnitEnum

defines units for time values

HiHiDelayInterval : string

is a variant containing a numeric value indicating the delay interval when alarm goes into the Alarm High state

HiHiDelayUnit : CimTimeUnitEnum

defines units for time values

HiHiOffDelayInterval : string

is a variant containing a numeric value indicating the delay interval when alarm goes from the Alarm High state to Normal state

HiHiOffDelayUnit : CimTimeUnitEnum

defines units for time values

HiOffDelayInterval : string

is a variant containing a numeric value indicating the delay interval when alarm goes from the Warning High state to Normal state

HiOffDelayUnit : CimTimeUnitEnum

defines units for time values

LoDelayInterval : string

is a variant containing a numeric value indicating the delay interval when alarm goes into the Warning Low state

LoDelayUnit : CimTimeUnitEnum

defines units for time values

LoLoDelayInterval : string

is a variant containing a numeric value indicating the delay interval when alarm goes into the Alarm Low state

LoLoDelayUnit : CimTimeUnitEnum

defines units for time values

LoLoOffDelayInterval : string

is a variant containing a numeric value indicating the delay interval when alarm goes from the Alarm Low state to Normal State

LoLoOffDelayUnit : CimTimeUnitEnum

defines units for time values

LoOffDelayInterval : string

is a variant containing a numeric value indicating the delay interval when alarm goes from the Warning Low state to Normal state

LoOffDelayUnit : CimTimeUnitEnum

defines units for time values

TimeInterval : string

is a variant containing a numeric value indicating the time interval when using a rate of change or alarm delay

TimeUnit : CimTimeUnitEnum

defines units for time values

WarningHigh : string

contains a variant indicating the warning high limit for the point

WarningLow : string

contains a variant indicating the warning low limit for the point

Properties

Name	Description	Data Type
Alarm	object provides an interface to CIMPLICITY Alarm configuration	CimAlarm
Alarm\AckTimeout	is a long integer that indicates when automatic alarm acknowledgement should happen. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm	integer
Alarm\AlarmClass	is a string containing the class of the alarm	string
Alarm\AlarmDescription	is a string containing the description of the alarm, This attribute shall be ignored in case of point alarm	string
Alarm\AlarmID	is a string containing the Alarm ID. When accessed from a Point Alarm, this property is read-only because the Alarm ID is the same as the Point ID	string
Alarm\AlarmMessage	is a string containing the alarm message. Note When accessed from a Point Alarm, this property is read-only because the structure of the point alarm message defines the alarm message	string
Alarm\AlarmTypeID	is a string containing the alarm type id of the alarm. When accessed from a Point Alarm, this property is read-only because the structure of the point alarm message defines the Alarm Type Id	string
Alarm\Changeapproval	defines different change approval data setting. The numeric value of these enumerations can be used in an expression of a class data item for the $APPROVAL_TYPE field	CimChangeapprovalEnum
Alarm\DeleteOpt	defines the deletion options available for an alarm	CimAlarmDelOptEnum
Alarm\HelpFileName	is a string containing the name of the alarm help file. The string must be prefixed with AM_HELP:\ in order for the file to be found by the alarm viewer and must have the extension HLP.	string
Alarm\HiAckTimeout	The CimAlarm.HiAckTimeout is a long integer that indicates when automatic alarm acknowledgement should happen while the alarm in the Warning High state. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm	integer
Alarm\HiDeleteOpt	defines the deletion options available for an alarm	CimAlarmDelOptEnum
Alarm\HiHiAckTimeout	The CimAlarm.HiHiAckTimeout is a long integer that indicates when automatic alarm acknowledgement should happen while the alarm in the Alarm High state. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm	integer
Alarm\HiHiDeleteOpt	defines the deletion options available for an alarm	CimAlarmDelOptEnum
Alarm\HiHiLogOpt	The CimAlarm.HiHiLogOpt is a string that indicates what the alarm transitions in the Alarm High state should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated	string
Alarm\HiHiRepeatTimeout	is a long integer that indicates when automatic alarm repeat should occur while the alarm is in the Alarm High state. 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm	integer
Alarm\HiHiResetAllowed	is a boolean that indicates if the alarm can be manually reset when it is in the Alarm High state	boolean
Alarm\HiHiResetTimeout	The CimAlarm.HiHiResetTimeout is a long integer that indicates when automatic alarm reset should happen while the alarm in the Alarm High state. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm	integer
Alarm\HiLogOpt	The CimAlarm.HiLogOpt is a string that indicates what the alarm transitions in the Warning High state should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated	string
Alarm\HiRepeatTimeout	is a long integer that indicates when automatic alarm repeat should occur while the alarm is in the Warning High state. 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm	integer
Alarm\HiResetAllowed	is a boolean that indicates if the alarm can be manually reset when it is in the Warning High state	boolean
Alarm\HiResetTimeout	The CimAlarm.HiResetTimeout is a long integer that indicates when automatic alarm reset should happen while the alarm in the Warning High state. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm	integer
Alarm\LoAckTimeout	is a long integer that indicates when automatic alarm acknowledgement should happen while the alarm in the Warning Low state. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm.	integer
Alarm\LoDeleteOpt	defines the deletion options available for an alarm	CimAlarmDelOptEnum
Alarm\LoLoAckTimeout	is a long integer that indicates when automatic alarm acknowledgement should happen while the alarm in the Alarm Low state. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm	integer
Alarm\LoLoDeleteOpt	defines the deletion options available for an alarm	CimAlarmDelOptEnum
Alarm\LoLoLogOpt	is a string that indicates what the alarm transitions in the Alarm Low state should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated	string
Alarm\LoLoRepeatTimeout	is a long integer that indicates when automatic alarm repeat should occur while the alarm is in the Alarm Low state. 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm	integer
Alarm\LoLoResetAllowed	is a boolean that indicates if the alarm can be manually reset when it is in the Alarm Low state	boolean
Alarm\LoLoResetTimeout	The CimAlarm.LoLoResetTimeout is a long integer that indicates when automatic alarm reset should happen while the alarm in the Alarm Low state. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm	integer
Alarm\LoLogOpt	The CimAlarm.LoLogOpt is a string that indicates what the alarm transitions in the Warning Low state should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated	string
Alarm\LoRepeatTimeout	is a long integer that indicates when automatic alarm repeat should occur while the alarm is in the Warning Low state. 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm	integer
Alarm\LoResetAllowed	is a boolean that indicates if the alarm can be manually reset when it is in the Warning Low state	boolean
Alarm\LoResetTimeout	is a long integer that indicates when automatic alarm reset should happen while the alarm in the Warning Low state. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm	integer
Alarm\LogOpt	The CimAlarm.LogOpt is a string that indicates when the alarm should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated	string
Alarm\MaxStacked	is a long integer that indicates how many alarms to stack. Defaults to zero if not specified. Maximum value is 20	integer
Alarm\Published	is a boolean used to enable or disable publishing to SOA for an alarm. Defaults to FALSE for a new alarm	boolean
Alarm\RepeatTimeout	is a long integer that indicates when automatic alarm repeat should occur 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm	integer
Alarm\ResetAllowed	is a boolean that indicates if the alarm can be manually reset	boolean
Alarm\ResetTimeout	The CimAlarm.ResetTimeout is a long integer that indicates when automatic alarm reset should happen. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm	integer
Alarm\Routing	returns an object containing the alarm routing for the alarm	Array[string]
Alarm\Severity	is a short that indicates the alarm severity	integer
AlarmConfigured	is a boolean indicating if alarming is configured for the point	boolean
AlarmCriteria	defines types of alarming available	CimPointAlarmEnum
AlarmDelay	is a boolean indicating if the alarm generation should be delayed. When alarm delay is enabled specify the TimeInterval and TimeUnit for the delay. AlarmDelay cannot be used with a Rate of Change alarm criteria	boolean
AlarmHigh	contains a variant indicating the alarm high limit for the point	string
AlarmLow	contains a variant indicating the alarm low limit for the point	string
AlarmMessage	is a string containing the point alarm message to be used when an alarm is generated for the point	string
AlarmOffDelay	is a boolean indicating if the moving alarm to normal state should be delayed. When alarm off delay is enabled specify the TimeInterval and TimeUnit for the delay. AlarmOffDelay cannot be used with a Rate of Change alarm criteria	boolean
AlarmStrID	is a integer containing the Alarm String to use when generating point alarms. Defaults to 1	integer
AlarmValueUpdate	is a boolean indicating if the %VAL field in the alarm message should be updated while the point is in ana alarm state	boolean
DeviationPtID	is a string containing the name of the deviation point. The deviation point must be specified when the alarm criteria is cimAlarmDeviation	string
HiDelayInterval	is a variant containing a numeric value indicating the delay interval when alarm goes into the Warning High state	string
HiDelayUnit	defines units for time values	CimTimeUnitEnum
HiHiDelayInterval	is a variant containing a numeric value indicating the delay interval when alarm goes into the Alarm High state	string
HiHiDelayUnit	defines units for time values	CimTimeUnitEnum
HiHiOffDelayInterval	is a variant containing a numeric value indicating the delay interval when alarm goes from the Alarm High state to Normal state	string
HiHiOffDelayUnit	defines units for time values	CimTimeUnitEnum
HiOffDelayInterval	is a variant containing a numeric value indicating the delay interval when alarm goes from the Warning High state to Normal state	string
HiOffDelayUnit	defines units for time values	CimTimeUnitEnum
LoDelayInterval	is a variant containing a numeric value indicating the delay interval when alarm goes into the Warning Low state	string
LoDelayUnit	defines units for time values	CimTimeUnitEnum
LoLoDelayInterval	is a variant containing a numeric value indicating the delay interval when alarm goes into the Alarm Low state	string
LoLoDelayUnit	defines units for time values	CimTimeUnitEnum
LoLoOffDelayInterval	is a variant containing a numeric value indicating the delay interval when alarm goes from the Alarm Low state to Normal State	string
LoLoOffDelayUnit	defines units for time values	CimTimeUnitEnum
LoOffDelayInterval	is a variant containing a numeric value indicating the delay interval when alarm goes from the Warning Low state to Normal state	string
LoOffDelayUnit	defines units for time values	CimTimeUnitEnum
TimeInterval	is a variant containing a numeric value indicating the time interval when using a rate of change or alarm delay	string
TimeUnit	defines units for time values	CimTimeUnitEnum
WarningHigh	contains a variant indicating the warning high limit for the point	string
WarningLow	contains a variant indicating the warning low limit for the point	string